Artemis Appointment API

(0 reviews)

Available Appointments Overview

For new Product installations, you will need to find and reserve an appointment.

If you wish to book an installation date and slot for a Product order, you may do so using the Artemis Appointing Experience API to check appointment availability and to reserve an appointment. Before selecting an appointment, you must decide which appointment type you require and for which Product.

For the PXC Products, the following appointments are available:

FTTP

Managed Install Appointment - Required for installation of a new FTTP ONT

SOGEA

Self-Install Appointment - Required when the end user would like to nominate a specific date for the PCP work to go ahead. (Self-Install appointments are defaulted to "ALLDAY time-slots, however for a small charge, you can specify a AM or PM time-slot to shorten the window, when Openreach will complete the PCP work

Managed Install Appointment - Required for installation of a new line/NTE

Note: In addition to selecting your appointment type and timeslot, there are other appointment characteristics which are required to check for available appointments per Product

Get Available Appointment Characteristics:

City Fibre FTTP

HTTP Method	Key	Value(s)	Value Type	Validation
POST	billingAccount.id	"12345678"	string	Mandatory
POST	appointmentType	"Standard"	string	Mandatory
POST	productName	"C-CFH-FTTP"	string	Mandatory
POST	productSpeed	"0.5/0.5", "40/10", "80/20", "115/20, "160/30", "220/30, "330/50", "550/75" or "1000/115"	string	Mandatory
POST	provisioningCommand	"ProvideNew"	string	Mandatory
POST	addressType	"UPRN"	string	Mandatory
POST	uprn	"117084194"	string	Mandatory
POST	appointmentFromDate	"2024-09-09"	string	Mandatory

Openreach FTTP

HTTP Method	Key	Value(s)	Value Type	Validation
POST	billingAccount.id	"12345678"	string	Mandatory
POST	appointmentType	"Standard"	string	Mandatory
POST	productName	"C-OR-FTTP"	string	Mandatory
POST	productSpeed	"0.5/0.5", "40/10", "80/20", "115/20", "160/30", "220/30, "330/50", "550/75" or "1000/115"	string	Mandatory
POST	provisioningCommand	"ProvideNew", "Switch", "Takeover", "Restart", "SwitchToNew", "SwitchToStop" "ReplaceToNew or "ReplaceToStop"	string	Mandatory
POST	addressType	"GALK"	string	Mandatory
POST	galk	"A00031290370"	string	Mandatory
POST	districtCode	"ES"	string	Mandatory
POST	siteVisitReason	"Standard", "Premium", "Advanced" or "Prove IP Voice"	string	Mandatory
POST	appointmentFromDate	"2024-09-09"	string	Mandatory

Openreach SOGEA

HTTP Method	Key	Value(s)	Value Type	Validation
POST	billingAccount.id	"12345678"	string	Mandatory
POST	appointmentType	"Standard" or "Flexible"	string	Mandatory
POST	productName	"C-OR-FTTP"	string	Mandatory
POST	productSpeed	"0.5/0.5", "40/10" or "80/20"	string	Mandatory
POST	provisioningCommand	"ProvideNew", "Switch", "Takeover", "Restart", or "Replace"	string	Mandatory
POST	addressType	"GALK"	string	Mandatory
POST	galk	"A00031290370"	string	Mandatory
POST	districtCode	"ES"	string	Mandatory
POST	siteVisitReason	"Standard", "Premium", "Advanced", "Prove IP Voice" or No Site Visit"	string	Mandatory
POST	appointmentFromDate	"2024-09-09"	string	Mandatory

Response

The API will respond with the available installation appointment dates and timeslots from the specified supplier in the following format:

{
    "appointmentDate": "2024-09-24",

    "appointmentStartTime": "08:00",

    "appointmentEndTime": "13:00",

    "appointmentTimeslot": "AM"

},

{

    "appointmentDate": "2024-09-24",

    "appointmentStartTime": "13:00",

    "appointmentEndTime": "18:00",

    "appointmentTimeslot": "PM"

}

The appointment time-slots currently returned by PXC suppliers are:

Appointment Time-slot	Period
AM	08:00 to 13:00
PM	13:00 to 18:00
ALLDAY	08:00 to 18:00

Based on the available dates presented in the GetAvailableAppointments response, you can select a date and proceed with reserving the preferred appointment date and time-slot.

Available Appointments Overview

Reviews